/*
 * Copyright (C) 2016 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 */
package androidx.test.espresso.remote.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Class fields annotated with the {@link RemoteMsgField} annotation are automatically serialised to
 * their proto representation when used in combination with a {@link
 * androidx.test.espresso.remote.GenericRemoteMessage}.
 *
 * <p>The order field is mandatory and represents the declared field order in the class this
 * annotation is used in. The order must match the declared constructor param types of the
 * constructor annotated with {{@link RemoteMsgConstructor}}.
 *
 * @see androidx.test.espresso.remote.GenericRemoteMessage
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface RemoteMsgField {
  /** Returns the order of this field. Order values need to start with 0. */
  int order();
}
